GPX (GPS Exchange)
Common format supported by many vendors and programs. Lowrance only provides
- minimal support for GPX export with their HOOK2 series. Waypoints include
+ minimal support for GPX export with their HOOK2 series. Waypoints include
longitude, latitude, timestamp, name and symbol information. Routes include
name and for route points longitude, latitude, timestamp, name, and symbol.
Tracks include name and for track points longitude, latitude, and timestamp.
#include <QtCore/QList> // for QList
#include <QtCore/QScopedPointer> // for QScopedPointer
#include <QtCore/QString> // for QString, operator+, operator==, operator!=
-#include <QtCore/QStringRef> // for QStringRef
#include <QtCore/QTextCodec> // for QTextCodec, QTextCodec::IgnoreHeader
#include <QtCore/QTextEncoder> // for QTextEncoder
#include <QtCore/QTime> // for QTime
-#include <QtCore/QVector> // for QVector
#include <QtCore/Qt> // for CaseInsensitive, UTC
#include <QtCore/QtGlobal> // for qPrintable, uint, qAsConst, QAddConst<>::Type
#include "defs.h"
+#include "lowranceusr.h"
#include "formspec.h" // for FsChainFind, FsChainAdd, kFsLowranceusr4, FormatSpecificData
#include "gbfile.h" // for gbfgetint32, gbfputint32, gbfputint16, gbfgetc, gbfgetint16, gbfwrite, gbfputc, gbfeof, gbfgetflt, gbfclose, gbfgetdbl, gbfopen_le, gbfputdbl, gbfputs, gbfile, gbfputflt, gbfread, gbfseek
#include "src/core/datetime.h" // for DateTime
#include "src/core/logging.h" // for Warning
-struct lowranceusr_icon_mapping_t {
- int value;
- const char* icon;
-};
-
-#define DEF_ICON 10001
-#define X_1_ICON 10003
-#define DISABLED_CACHE_TXT "Disabled Cache"
-
-const lowranceusr_icon_mapping_t lowranceusr_icon_value_table[] = {
-
- /* Taken from iFinder 1.8 */
-
- { 10000, "diamond 1" }, // a.k.a. WPTa on iFinder Hunt C
- { 10001, "diamond 2" }, // a.k.a. WPTb on iFinder Hunt C
- { 10002, "diamond 3" },
- { X_1_ICON, "x 1" }, // a.k.a. Xa on iFinder Hunt C
- { 10004, "x 2" }, // a.k.a. Xb on iFinder Hunt C
- { 10005, "x 3" },
- { 10006, "red cross" },
- { 10007, "house" },
- { 10008, "car" }, // a.k.a. vehicle on iFinder Hunt C
- { 10009, "store" },
- { 10010, "gas station" }, // a.k.a. gas on iFinder Hunt C
- { 10011, "fork and spoon" }, // a.k.a. food on iFinder Hunt C
- { 10012, "telephone" }, // a.k.a. phone on iFinder Hunt C
- { 10013, "airplane" },
- { 10014, "exit sign" },
- { 10015, "stop sign" },
- { 10016, "exclamation" },
- { 10017, "traffic light" },
- { 10018, "american flag" },
- { 10019, "person" }, // a.k.a. partner on iFinder Hunt C
- { 10020, "restrooms" },
- { 10021, "tree" },
- { 10022, "mountains" },
- { 10023, "campsite" }, // a.k.a. camp on iFinder Hunt C
- { 10024, "picnic table" }, // a.k.a. picnic on iFinder Hunt C
- { 10025, "deer" }, // a.k.a. big game on iFInder Hunt C
- { 10026, "deer tracks" },
- { 10027, "turkey tracks" },
- { 10028, "tree stand" },
- { 10029, "bridge" },
- { 10030, "skull and crossbones" }, // a.k.a. skull on iFinder Hunt C
- { 10031, "fish" },
- { 10032, "two fish" },
- { 10033, "dive flag" },
- { 10034, "wreck" },
- { 10035, "anchor" },
- { 10036, "boat" },
- { 10037, "boat ramp" },
- { 10038, "flag buoy" },
- { 10039, "dam" },
- { 10040, "swimmer" },
- { 10041, "pier"},
-
- /* The descriptions come from Alan Porter <alan@kr4jb.net>, using an iFinder Expedition C */
- /* Updated by bj.kowalski with ICON names from iFinder Hunt C SW Version 1.2.0 */
-
- { 10042, "icon42" }, // black box with red X
- { 10043, "red dot" }, // small red dot (route point)
- { 10044, "atv" }, // 4-wheeler
- { 10045, "blind" }, // hiding hunter
- { 10046, "oak tree" }, // tree (yellow base)
- { 10047, "icon47" }, // windmill
- { 10048, "camera" }, // camera
- { 10049, "rub" }, // tree (something in front of base)
- { 10050, "scrape" }, // tree (something hanging from left side)
- { 10051, "droppings" }, // 4 dots in rhombus shape
- { 10052, "roost tree" }, // bare winter tree
- { 10053, "animal bed" }, // hiding deer head peeking over bushes
- { 10054, "feeder" }, // piston? over a pile of salt?
- { 10055, "food plot" }, // corn
- { 10056, "turkey" }, // turkey
- { 10057, "waterfowl" }, // duck
- { 10058, "upland" }, // hen
- { 10059, "small game" }, // rabbit
- { 10060, "predator paw" }, // paw print
- { 10061, "blood" }, // 2 red flames?
-
- /* This list comes from 'wifinder' from ifinder H20 Color */
-
- { 10062, "Interesting Land Feature" },
- { 10063, "Global Location" },
- { 10064, "Note" },
- { 10065, "Ghost" },
- { 10066, "Letter" },
- { 10067, "Multi-Treasure" },
- { 10068, "Mystery Or Puzzle" },
- { 10069, "Treasure" },
- { 10070, "Webmail" },
- { 10071, "Sun" },
- { 10072, "Musical Note" },
- { 10073, "Camera/Movie Theater" },
- { 10074, "Star" },
- { 10075, "Coffee Mug" },
- { 10076, "Books" },
- { 10077, "Historical Marker" },
- { 10078, "Tools/Repair" },
- { 10079, "Favorite" },
- { 10080, "Arena" },
- { 10081, "Golf Course" },
- { 10082, "Money/Atm" },
-
- /* This list comes from HOOK2 provided by BJ.Kowalski */
-
- { 10083, "longgrass" },
- { 10084, "rocks" },
- { 10086, "hump" },
- { 10087, "hole" },
-
- /* The following list is from TopoFusion */
-
- { 10000, "Waypoint" }, /* diamond 1 */
- { DEF_ICON, "Text Label (No Dot)" },
- { 10018, "Trailhead" }, /* american flag */
- { 10023, "Campground" }, /* campsite */
- { 10022, "Summit" }, /* mountains */
- { DEF_ICON, "Tall Tower" },
- { DEF_ICON, "Short Tower" },
- { 10021, "Forest" }, /* tree */
- { DEF_ICON, "Mine" },
-//{ 10038, "Geocache" }, /* flag buoy */
-//{ 10016, "Geocache Found" }, /* exclamation */
- { DEF_ICON, "Skiing Area" },
- { 10029, "Crossing" }, /* bridge */
- { 10007, "House" }, /* house */
- { X_1_ICON, "Dot" }, /* x 1 */
- { 10025, "Hunting Area" }, /* deer */
- { 10031, "Fishing Area" }, /* fish */
- { 10040, "Swimming Area" }, /* swimmer */
- { 10012, "Telephone" }, /* telephone */
- { 10024, "Rest Area" }, /* picnic table */
- { 10021, "Park" }, /* tree */
- { 10007, "Information" }, /* house */
- { 10022, "Scenic Area" }, /* mountains */
- { DEF_ICON, "Bank/Dollar" },
- { 10009, "Hotel" }, /* store */
- { 10011, "Restaurant" }, /* fork and spoon */
- { 10030, "Danger Area" }, /* skull and crossbones */
- { 10035, "Anchor" }, /* anchor */
- { 10002, "City (Large)" }, /* diamond 3 */
- { 10001, "City (Medium)" }, /* diamond 2 */
- { 10000, "City (Small)" }, /* diamond 1 */
- { DEF_ICON, "Drinking Water" },
- { 10008, "Parking Area" }, /* car */
- { 10023, "RV Park" }, /* campsite */
- { 10020, "Rest Room" }, /* restroom */
- { 10019, "Shower" }, /* person */
- { DEF_ICON, "Tunnel" },
-
- /* These are the icons that gpsbabel will use */
-
- { 10038, "Geocache" }, // flag buoy
- { 10016, "Geocache Found" }, // exclamation
- { 10043, "Micro-Cache" }, // small red dot
- { 10065, "Virtual cache" }, // ghost
- { 10051, "Multi-Cache" }, // 4 dots in rhombus shape
- { 10068, "Unknown Cache" }, // ? mark
- { 10045, "Locationless (Reverse) Cache" }, // hiding hunter
- { 10066, "Post Office" }, // letter
- { 10019, "Event Cache" }, // person
- { 10070, "Webcam Cache" }, // webcam
- { 10042, DISABLED_CACHE_TXT }, // black box with red X
-
- // END OF ICON MAPPING
- { -1, nullptr }
-};
-
-#define DEF_USR4_ICON 2
-#define DEF_USR4_COLOR 0
-
-struct lowranceusr4_icon_mapping_t {
- int value;
- const char* icon;
- const char* color[7];
-};
-
-const lowranceusr4_icon_mapping_t lowranceusr4_icon_value_table[] = {
-
- /* USR GPX Symbol COLOR1 COLOR2 COLOR3 COLOR4 COLOR5 COLOR6 COLOR7 HOOK2 Displays */
-
- { 1, "diamond 1" , { "blue", "magenta", "orange", "yellow", "green", "aqua", "white" }}, // diamond
- { 0, "diamond 1" , { "blue", "magenta", "orange", "yellow", "green", "aqua", "white" }}, // diamond
- { 1, "diamond 2" , { "blue", "magenta", "orange", "yellow", "green", "aqua", "white" }}, // diamond
- { 1, "diamond 3" , { "blue", "magenta", "orange", "yellow", "green", "aqua", "white" }}, // diamond
- { 2, "x 1" , { "blue", "magenta", "orange", "yellow", "green", "aqua", "white" }}, // X
- { 2, "x 2" , { "blue", "magenta", "orange", "yellow", "green", "aqua", "white" }}, // X
- { 2, "x 3" , { "blue", "magenta", "orange", "yellow", "green", "aqua", "white" }}, // X
- { 4, "fish" , { "green", "aqua", "blue", "magenta", "red", "yellow", "white" }}, // single fish
- { 5, "two fish" , { "aqua", "blue", "red", "orange", "yellow", "green", "white" }}, // schoolfish
- { 8, "hole" , { "aqua", "blue", "red", "orange", "yellow", "green", "white" }}, // dip sign
- { 9, "hump" , { "aqua", "blue", "red", "orange", "yellow", "green", "white" }}, // bump sign
- { 10, "longgrass" , { "green", "aqua", "blue", "red", "orange", "yellow", "white" }}, // long grass
- { 12, "rocks" , { "blue", "magenta", "orange", "yellow", "green", "aqua", "white" }}, // rocks
- { 17, "gas station" , { "red", "yellow", "green", "aqua", "blue", "magenta", "white" }}, // gas pump
- { 28, "tree" , { "green", "aqua", "blue", "magenta", "red", "yellow", "white" }}, // tree
- { 30, "campsite" , { "yellow", "green", "aqua", "blue", "magenta", "red", "white" }}, // tent
- { 37, "skull and crossbones", { "blue", "magenta", "orange", "yellow", "green", "aqua", "white" }}, // skull and crossbones
- { 40, "dive flag" , { "red", "yellow", "green", "aqua", "blue", "magenta", "white" }}, // diveflag
- { 42, "anchor" , { "blue", "magenta", "orange", "yellow", "green", "aqua", "white" }}, // anchor
- { 44, "boat ramp" , { "red", "yellow", "green", "aqua", "blue", "magenta", "white" }}, // boatramp
- { 48, "pier" , { "blue", "magenta", "orange", "yellow", "green", "aqua", "white" }}, // pier
-
- // END OF ICON MAPPING
- { -1, nullptr , { nullptr, nullptr, nullptr, nullptr, nullptr, nullptr, nullptr }}
-};
-
-static gbfile* file_in;
-static gbfile* file_out;
-static short_handle mkshort_handle;
-
-static route_head* trk_head;
-static route_head* rte_head;
-
-static int waypt_uid;
-static int route_uid;
-static int trail_uid;
-
-static char* opt_ignoreicons;
-static char* opt_writeasicons;
-static char* opt_seg_break;
-static char* opt_wversion;
-static char* opt_title;
-static char* opt_content_descr;
-static char* opt_serialnum;
-static int opt_serialnum_i;
-
-static QList<const Waypoint*>* waypt_table{nullptr};
-
/* from waypt.c, we need to iterate over waypoints when extracting routes */
extern WaypointList* global_waypoint_list;
-static unsigned short waypt_out_count;
-static int trail_count, lowrance_route_count;
-static int trail_point_count;
-static char continuous = 1;
-static short num_section_points;
-static char* merge;
-static int reading_version;
-static int rstream_version;
-static int writing_version;
-static QTextCodec* utf16le_codec{nullptr};
-
#define MYNAME "Lowrance USR"
-#define MAXUSRSTRINGSIZE 256
-#define SEMIMINOR 6356752.3142
-//#define DEGREESTORADIANS 0.017453292
-//#define DEGREESTORADIANS 0.01745329252 // increased accuracy in calculations
-#define DEGREESTORADIANS (M_PI/180.0)
-#define MAX_TRAIL_POINTS 9999
-#define UNKNOWN_USR_ALTITUDE METERS_TO_FEET(-10000) /* -10000ft is how the unit stores unknown */
-
-/* Jan 1, 2000 00:00:00 */
-const time_t base_time_secs = 946706400;
-
-struct lowranceusr4_fsdata : FormatSpecificData {
- lowranceusr4_fsdata() : FormatSpecificData(kFsLowranceusr4) {}
-
- lowranceusr4_fsdata* clone() const override
- {
- return new lowranceusr4_fsdata(*this);
- }
-
- uint uid_unit{0};
- uint uid_unit2{0};
- int uid_seq_low{0};
- int uid_seq_high{0};
- uint UUID1{0};
- uint UUID2{0};
- uint UUID3{0};
- uint UUID4{0};
- int flags{0};
- int color{0};
- const char *color_desc{nullptr};
- int icon_num{0};
- float depth{0.0};
-};
-
-class Lowranceusr4Timestamp {
- public:
- unsigned int julian_day_number;
- unsigned int milliseconds;
-
- Lowranceusr4Timestamp(unsigned int jd, unsigned int ms) : julian_day_number{jd}, milliseconds{ms} {}
-};
-
-
+// Until c++17 we have to define odr-used constexpr static data members at namespace scope.
+#if __cplusplus < 201703L
+constexpr int LowranceusrFormat::DEF_ICON;
+constexpr int LowranceusrFormat::X_1_ICON;
+constexpr const char* LowranceusrFormat::DISABLED_CACHE_TXT;
+// MSVC 2015 will error with C2373 if the array length isn't explicitly included.
+#if !defined(_MSC_VER) || (_MSC_VER >= 1910) /* !MSVC or MSVC 2017 or newer */
+constexpr LowranceusrFormat::lowranceusr_icon_mapping_t LowranceusrFormat::lowranceusr_icon_value_table[];
+#else
+constexpr LowranceusrFormat::lowranceusr_icon_mapping_t LowranceusrFormat::lowranceusr_icon_value_table[134];
+#endif
+constexpr int LowranceusrFormat::DEF_USR4_ICON;
+constexpr int LowranceusrFormat::DEF_USR4_COLOR;
+// MSVC 2015 will error with C2373 if the array length isn't explicitly included.
+#if !defined(_MSC_VER) || (_MSC_VER >= 1910) /* !MSVC or MSVC 2017 or newer */
+constexpr LowranceusrFormat::lowranceusr4_icon_mapping_t LowranceusrFormat::lowranceusr4_icon_value_table[];
+#else
+constexpr LowranceusrFormat::lowranceusr4_icon_mapping_t LowranceusrFormat::lowranceusr4_icon_value_table[22];
+#endif
+constexpr int LowranceusrFormat::MAXUSRSTRINGSIZE;
+constexpr double LowranceusrFormat::SEMIMINOR;
+constexpr double LowranceusrFormat::DEGREESTORADIANS;
+constexpr int LowranceusrFormat::MAX_TRAIL_POINTS;
+constexpr double LowranceusrFormat::UNKNOWN_USR_ALTITUDE;
+constexpr time_t LowranceusrFormat::base_time_secs;
+#endif
/* below couple of functions mostly borrowed from raymarine.c */
/* make waypoint shortnames unique */
-static char
-same_points(const Waypoint* A, const Waypoint* B)
+char
+LowranceusrFormat::same_points(const Waypoint* A, const Waypoint* B)
{
return ( /* !!! We are case-sensitive !!! */
(A->shortname == B->shortname) &&
(A->longitude == B->longitude));
}
-static void
-register_waypt(const Waypoint* wpt)
+void
+LowranceusrFormat::register_waypt(const Waypoint* wpt) const
{
for (const Waypoint* cmp : qAsConst(*waypt_table)) {
if (same_points(wpt, cmp)) {
/* end borrowed from raymarine.c */
-static const Waypoint*
-lowranceusr4_find_waypt(uint uid_unit, int uid_seq_low, int uid_seq_high)
+const Waypoint*
+LowranceusrFormat::lowranceusr4_find_waypt(uint uid_unit, int uid_seq_low, int uid_seq_high) const
{
// Iterate with waypt_disp_all?
for (const Waypoint* waypointp : qAsConst(*global_waypoint_list)) {
return nullptr;
}
-static const Waypoint*
-lowranceusr4_find_global_waypt(uint id1, uint id2, uint id3, uint id4)
+const Waypoint*
+LowranceusrFormat::lowranceusr4_find_global_waypt(uint id1, uint id2, uint id3, uint id4) const
{
// Iterate with waypt_disp_all?
for (const Waypoint* waypointp : qAsConst(*global_waypoint_list)) {
}
// Starting with USR 4, adopted a UTF-16 character string format
-static QString
-lowranceusr4_readstr(gbfile* file, int bytes_per_char)
+QString
+LowranceusrFormat::lowranceusr4_readstr(gbfile* file, int bytes_per_char) const
{
QString retval;
}
// Starting with USR 4, adopted a UTF-16 character string format
-static void
-lowranceusr4_writestr(const QString& buf, gbfile* file, int bytes_per_char)
+void
+LowranceusrFormat::lowranceusr4_writestr(const QString& buf, gbfile* file, int bytes_per_char) const
{
QByteArray qba;
if (bytes_per_char == 1) {
gbfwrite(qba.constData(), 1, len, file);
}
-static gpsbabel::DateTime
-lowranceusr4_get_timestamp(unsigned int jd_number, unsigned int msecs)
+gpsbabel::DateTime
+LowranceusrFormat::lowranceusr4_get_timestamp(unsigned int jd_number, unsigned int msecs)
{
QDateTime qdt = QDateTime(QDate::fromJulianDay(jd_number), QTime(0, 0, 0), Qt::UTC).addMSecs(msecs);
return qdt;
}
-static Lowranceusr4Timestamp
-lowranceusr4_jd_from_timestamp(const gpsbabel::DateTime& qdt)
+LowranceusrFormat::Lowranceusr4Timestamp
+LowranceusrFormat::lowranceusr4_jd_from_timestamp(const gpsbabel::DateTime& qdt)
{
QDateTime jdt = qdt.toUTC();
unsigned int jd_number = jdt.date().toJulianDay();
return Lowranceusr4Timestamp(jd_number, msecs);
}
-template <typename T>
-static QString lowranceusr_common_find_desc_from_icon_number(const int icon, const T icon_value_table[])
-{
- for (const T* i = icon_value_table; i->icon; i++) {
- if (icon == i->value) {
- return i->icon;
- }
- }
-
- // Didn't find it in table, default to leave it as the number found
- return QString("icon-%1").arg(icon);
-}
-
-template <typename T>
-static int lowranceusr_common_find_icon_number_from_desc(const QString& desc, const T icon_value_table[], const int def_icon)
-{
- if (desc.isNull()) {
- return def_icon;
- }
-
- /*
- * If we were given a numeric icon number as a description
- * (i.e. 8255), just return that.
- * Also return the icon number for descriptions of "icon-"
- * followed by a numeric icon number.
- */
- int n = desc.midRef(desc.startsWith("icon-") ? 5 : 0).toInt();
- if (n) {
- return n;
- }
-
- for (const T* i = icon_value_table; i->icon; i++) {
- if (desc.compare(i->icon,Qt::CaseInsensitive) == 0) {
- return i->value;
- }
- }
-
- return def_icon;
-}
-
-static QString
-lowranceusr_find_desc_from_icon_number(const int icon)
+QString
+LowranceusrFormat::lowranceusr_find_desc_from_icon_number(const int icon)
{
return lowranceusr_common_find_desc_from_icon_number(icon, lowranceusr_icon_value_table);
}
-static int
-lowranceusr_find_icon_number_from_desc(const QString& desc)
+int
+LowranceusrFormat::lowranceusr_find_icon_number_from_desc(const QString& desc)
{
return lowranceusr_common_find_icon_number_from_desc(desc, lowranceusr_icon_value_table, DEF_ICON);
}
-static QString
-lowranceusr4_find_desc_from_icon_number(const int icon)
+QString
+LowranceusrFormat::lowranceusr4_find_desc_from_icon_number(const int icon)
{
return lowranceusr_common_find_desc_from_icon_number(icon, lowranceusr4_icon_value_table);
}
-static int
-lowranceusr4_find_icon_number_from_desc(const QString& desc)
+int
+LowranceusrFormat::lowranceusr4_find_icon_number_from_desc(const QString& desc)
{
return lowranceusr_common_find_icon_number_from_desc(desc, lowranceusr4_icon_value_table, DEF_USR4_ICON);
}
-static const char *
-lowranceusr4_find_color_from_icon_number_plus_color_index(const int icon, const int index)
+const char*
+LowranceusrFormat::lowranceusr4_find_color_from_icon_number_plus_color_index(const int icon, const int index)
{
for (const lowranceusr4_icon_mapping_t* i = lowranceusr4_icon_value_table; i->icon; i++) {
if (icon == i->value) {
return nullptr;
}
-static int
-lowranceusr4_find_index_from_icon_desc_and_color_desc(const QString& icon, const QString& color)
+int
+LowranceusrFormat::lowranceusr4_find_index_from_icon_desc_and_color_desc(const QString& icon, const QString& color)
{
if (icon.isNull()) {
return DEF_USR4_COLOR;
if (icon.compare(i->icon,Qt::CaseInsensitive) == 0) {
// Found ICON, now look for color
for (int index=0; index<7; index++) {
- if (color.compare(i->color[index],Qt::CaseInsensitive) == 0)
+ if (color.compare(i->color[index],Qt::CaseInsensitive) == 0) {
return index;
+ }
}
}
}
return DEF_USR4_COLOR;
}
-// Combined arguments from previous lowranceusr and lowranceusr4 into single set.
-// Use output format specified to determine if args are ignored.
-static
-QVector<arglist_t> lowranceusr_args = {
- {
- // Ignore Event Marker ICONs in input data
- "ignoreicons", &opt_ignoreicons, "(USR input) Ignore event marker icons on read",
- nullptr, ARGTYPE_BOOL, ARG_NOMINMAX, nullptr
- },
- {
- // Write Waypoint data as Event Marker ICONs
- "writeasicons", &opt_writeasicons, "(USR output) Treat waypoints as icons on write",
- nullptr, ARGTYPE_BOOL, ARG_NOMINMAX, nullptr
- },
- {
- "merge", &merge, "(USR output) Merge into one segmented trail",
- nullptr, ARGTYPE_BOOL, ARG_NOMINMAX, nullptr
- },
- {
- "break", &opt_seg_break, "(USR input) Break segments into separate trails",
- nullptr, ARGTYPE_BOOL, ARG_NOMINMAX, nullptr
- },
- {
- // Specify the Output USR Version to be generated
- "wversion", &opt_wversion, "(USR output) Write version",
- "2", ARGTYPE_INT, "2", "4", nullptr
- },
- {
- // Only used if Write Version is 4/5/6
- "title", &opt_title, "(USR output) Output file title string",
- "", ARGTYPE_STRING, ARG_NOMINMAX, nullptr
- },
- {
- // Only used if Write Version is 4/5/6
- "serialnum", &opt_serialnum, "(USR output) Device serial number",
- "0", ARGTYPE_INT, ARG_NOMINMAX, nullptr
- },
- {
- // Only used if Write Version is 4/5/6
- "description", &opt_content_descr, "(USR output) Output file content description",
- "", ARGTYPE_STRING, ARG_NOMINMAX, nullptr
- },
-
-};
-
-static void
-rd_init(const QString& fname)
+void
+LowranceusrFormat::rd_init(const QString& fname)
{
file_in = gbfopen_le(fname, "rb", MYNAME);
utf16le_codec = QTextCodec::codecForName("UTF-16LE");
}
-static void
-rd_deinit()
+void
+LowranceusrFormat::rd_deinit()
{
gbfclose(file_in);
utf16le_codec = nullptr;
}
-static void
-wr_init(const QString& fname)
+void
+LowranceusrFormat::wr_init(const QString& fname)
{
file_out = gbfopen_le(fname, "wb", MYNAME);
mkshort_handle = mkshort_new_handle();
waypt_table = new QList<const Waypoint*>;
}
-static void
-wr_deinit()
+void
+LowranceusrFormat::wr_deinit()
{
gbfclose(file_out);
mkshort_del_handle(&mkshort_handle);
* Latitude and longitude for USR coords are in the lowrance mercator meter
* format in WGS84. The below code converts them to degrees.
*/
-static double
-lon_mm_to_deg(double x)
+double
+LowranceusrFormat::lon_mm_to_deg(double x)
{
return x / (DEGREESTORADIANS * SEMIMINOR);
}
-static double
-lat_mm_to_deg(double x)
+double
+LowranceusrFormat::lat_mm_to_deg(double x)
{
return (2.0 * atan(exp(x / SEMIMINOR)) - M_PI / 2.0) / DEGREESTORADIANS;
}
-static long
-lon_deg_to_mm(double x)
+long
+LowranceusrFormat::lon_deg_to_mm(double x)
{
return round(x * SEMIMINOR * DEGREESTORADIANS);
}
-static long
-lat_deg_to_mm(double x)
+long
+LowranceusrFormat::lat_deg_to_mm(double x)
{
return round(SEMIMINOR * log(tan((x * DEGREESTORADIANS + M_PI / 2.0) / 2.0)));
}
-
-static void
-lowranceusr_parse_waypt(Waypoint* wpt_tmp, int object_num_present)
+void
+LowranceusrFormat::lowranceusr_parse_waypt(Waypoint* wpt_tmp, int object_num_present) const
{
/* Object num */
if (object_num_present) {
wpt_tmp->latitude = lat_mm_to_deg(gbfgetint32(file_in));
wpt_tmp->longitude = lon_mm_to_deg(gbfgetint32(file_in));
- /*
+ /*
* From available data, looks like stream version = 0 used float to store for altitude in feet
* and version 1 used int32. If that is found to not be the case may need to add flag for input.
* Only have a small sample size.
}
printf(" %+15.10f %+15.10f", wpt_tmp->latitude, wpt_tmp->longitude);
if (wpt_tmp->altitude == unknown_alt) {
- printf(" %13s", "UNKNOWN ALT");
+ printf(" %13s", "UNKNOWN ALT");
} else {
- printf(" %5d %7.1f", (int)METERS_TO_FEET(wpt_tmp->altitude), wpt_tmp->altitude);
+ printf(" %5d %7.1f", (int)METERS_TO_FEET(wpt_tmp->altitude), wpt_tmp->altitude);
}
} else {
printf(MYNAME " parse_waypt: Waypt name = '%s' Lat = %+f Lon = %+f alt = ",
printf(" '%s'", qPrintable(wpt_tmp->GetCreationTime().toString("yyyy/MM/dd hh:mm:ss")));
} else {
printf(MYNAME " parse_waypt: creation time '%s', waypt_time %ld\n",
- qPrintable(wpt_tmp->GetCreationTime().toString("yyyy/MM/dd hh:mm:ss")), waypt_time);
+ qPrintable(wpt_tmp->GetCreationTime().toString("yyyy/MM/dd hh:mm:ss")), waypt_time);
}
}
}
}
-static void
-lowranceusr4_parse_waypt(Waypoint* wpt_tmp)
+void
+LowranceusrFormat::lowranceusr4_parse_waypt(Waypoint* wpt_tmp) const
{
- int waypoint_version;
-
auto* fsdata = new lowranceusr4_fsdata;
wpt_tmp->fs.FsChainAdd(fsdata);
fsdata->uid_seq_high = gbfgetint32(file_in);
/* Waypt stream version number */
- waypoint_version = gbfgetint16(file_in);
+ int waypoint_version = gbfgetint16(file_in);
/* Waypoint name; input is 2 bytes per char, we convert to 1 */
QString name = lowranceusr4_readstr(file_in, 2);
}
printf(" %+15.10f %+15.10f", wpt_tmp->longitude, wpt_tmp->latitude);
printf(" %08x %4d %4d %7s", fsdata->flags, fsdata->icon_num, fsdata->color,
- (fsdata->color_desc == nullptr ? "unk" : qPrintable(fsdata->color_desc)));
+ (fsdata->color_desc == nullptr ? "unk" : qPrintable(fsdata->color_desc)));
if (desc.length() > 16) {
printf(" %6d %.13s...", desc.length(), qPrintable(desc));
} else {
}
}
-
-static void
-lowranceusr_parse_waypts()
+void
+LowranceusrFormat::lowranceusr_parse_waypts() const
{
int NumWaypoints;
case 6:
lowranceusr4_parse_waypt(wpt_tmp);
break;
- default:
- Warning() << MYNAME << ": Unknown internal version " << reading_version;
+ default:
+ Warning() << MYNAME << ": Unknown internal version " << reading_version;
}
waypt_add(wpt_tmp);
}
}
-static void
-lowranceusr_parse_route()
+void
+LowranceusrFormat::lowranceusr_parse_route() const
{
/* route name */
QString name = lowranceusr4_readstr(file_in, 1);
}
}
-static void
-lowranceusr4_parse_route()
+void
+LowranceusrFormat::lowranceusr4_parse_route() const
{
- int route_version;
int UUID1 = 0;
int UUID2 = 0;
int UUID3 = 0;
fsdata->uid_seq_high = gbfgetint32(file_in);
/* Route stream version number */
- route_version = gbfgetint16(file_in);
+ int route_version = gbfgetint16(file_in);
if (global_opts.debug_level > 1) {
printf(MYNAME " parse_route: Version = %d\n", route_version);
}
}
}
-static void
-lowranceusr_parse_routes()
+void
+LowranceusrFormat::lowranceusr_parse_routes()
{
short int num_routes;
}
}
-
/*
* Icons are automatically converted to waypoints unless
* option of ignoreicons is used
*/
-static void
-lowranceusr_parse_icons()
+void
+LowranceusrFormat::lowranceusr_parse_icons() const
{
short int num_icons = gbfgetint16(file_in);
}
}
-static void
-lowranceusr_parse_trail(int* trail_num)
+void
+LowranceusrFormat::lowranceusr_parse_trail(int* trail_num)
{
/* Trail name; input is 1 byte per char */
QString name = lowranceusr4_readstr(file_in, 1);
}
}
-static void
-lowranceusr4_parse_trail(int* trail_num)
+void
+LowranceusrFormat::lowranceusr4_parse_trail(int* trail_num) const
{
- int trail_version;
- int trail_color;
- int trail_flags;
-
auto* fsdata = new lowranceusr4_fsdata;
trk_head->fs.FsChainAdd(fsdata);
fsdata->uid_seq_high = gbfgetint32(file_in);
/* Trail stream version number */
- trail_version = gbfgetint16(file_in);
+ int trail_version = gbfgetint16(file_in);
if (global_opts.debug_level == 99) {
printf(MYNAME " parse_trails: trail Version %d\n", trail_version);
}
trk_head->rte_name = name;
}
if (global_opts.debug_level >= 2) {
- printf(MYNAME " parse_trails: Trail '%s'\n", qPrintable(trk_head->rte_name));
+ printf(MYNAME " parse_trails: Trail '%s'\n", qPrintable(trk_head->rte_name));
}
/* Flags, discard for now */
- trail_flags = gbfgetint32(file_in);
+ int trail_flags = gbfgetint32(file_in);
/* Color ID, discard for now */
- trail_color = gbfgetint32(file_in);
+ int trail_color = gbfgetint32(file_in);
/* Comment/description; input is 2 bytes per char, we convert to 1 */
QString desc = lowranceusr4_readstr(file_in, 2);
/* Some flag bytes */
if (global_opts.debug_level == 99) {
- printf (MYNAME " parse_trails: unknown flag bytes %02x %02x %02x\n",
- gbfgetc(file_in), gbfgetc(file_in), gbfgetc(file_in));
+ printf(MYNAME " parse_trails: unknown flag bytes %02x %02x %02x\n",
+ gbfgetc(file_in), gbfgetc(file_in), gbfgetc(file_in));
} else {
/* just discard */
gbfgetc(file_in);
/* Mysterious attribute "data count" */
int attr_count = gbfgetint32(file_in);
if (global_opts.debug_level == 99) {
- printf (MYNAME " parse_trails: attribute count %4d : (", attr_count);
+ printf(MYNAME " parse_trails: attribute count %4d : (", attr_count);
for (int i=0; i<attr_count; i++) {
if (trail_version == 5) {
printf("%08x ", gbfgetint32(file_in));
}
}
-
-static void
-lowranceusr_parse_trails()
+void
+LowranceusrFormat::lowranceusr_parse_trails()
{
int num_trails;
int trail_num;
}
}
-static void
-data_read()
+void
+LowranceusrFormat::read()
{
reading_version = gbfgetint16(file_in);
rstream_version = gbfgetint16(file_in);
}
-static void
-lowranceusr_waypt_disp(const Waypoint* wpt)
+void
+LowranceusrFormat::lowranceusr_waypt_disp(const Waypoint* wpt) const
{
int Time, SymbolId, alt;
}
}
-static void
-lowranceusr4_waypt_disp(const Waypoint* wpt)
+void
+LowranceusrFormat::lowranceusr4_waypt_disp(const Waypoint* wpt)
{
const auto* fs = reinterpret_cast<lowranceusr4_fsdata*>(wpt->fs.FsChainFind(kFsLowranceusr4));
int SymbolId, ColorId;
if (get_cache_icon(wpt) && wpt->icon_descr.compare(QLatin1String("Geocache Found")) == 0) {
- if(writing_version == 4) {
+ if (writing_version == 4) {
SymbolId = lowranceusr4_find_icon_number_from_desc(wpt->icon_descr);
} else {
SymbolId = lowranceusr_find_icon_number_from_desc(get_cache_icon(wpt));
gbfputint32(0, file_out);
}
-
-static void
-lowranceusr_waypt_pr(const Waypoint* wpt)
+void
+LowranceusrFormat::lowranceusr_waypt_pr(const Waypoint* wpt)
{
/* our personal waypoint counter */
lowranceusr_waypt_disp(wpt);
}
-static void
-lowranceusr4_write_waypoints()
+void
+LowranceusrFormat::lowranceusr4_write_waypoints()
{
/* enumerate all waypoints from both the plain old waypoint list and
also all routes */
- waypt_disp_all(register_waypt);
- route_disp_all(nullptr, nullptr, register_waypt);
+ auto register_waypt_lambda = [this](const Waypoint* waypointp)->void {
+ register_waypt(waypointp);
+ };
+ waypt_disp_all(register_waypt_lambda);
+ route_disp_all(nullptr, nullptr, register_waypt_lambda);
if (global_opts.debug_level >= 1) {
printf(MYNAME " writing %d waypoints\n", waypt_table->size());
}
}
-
/*
* In Lowrance parlance, an "Icon" is a waypoint but without any
* kind of a name. The header count of icons has already been written
* 4 bytes long
* 4 bytes symbol
*/
-static void
-lowranceusr_write_icon(const Waypoint* wpt)
+void
+LowranceusrFormat::lowranceusr_write_icon(const Waypoint* wpt) const
{
int latmm = lat_deg_to_mm(wpt->latitude);
int lonmm = lon_deg_to_mm(wpt->longitude);
* == broken up into sections
*/
-static void
-lowranceusr_trail_hdr(const route_head* trk)
+void
+LowranceusrFormat::lowranceusr_trail_hdr(const route_head* trk)
{
QString name;
char visible=1;
trail_point_count=1;
}
-static void
-lowranceusr_route_hdr(const route_head* rte)
+void
+LowranceusrFormat::lowranceusr_route_hdr(const route_head* rte)
{
QString name;
qPrintable(rte->rte_name), num_legs);
}
-static void
-lowranceusr4_route_hdr(const route_head* rte)
+void
+LowranceusrFormat::lowranceusr4_route_hdr(const route_head* rte)
{
if (global_opts.debug_level >= 1) {
printf(MYNAME " writing route #%d (%s) with %d waypts\n",
gbfputint32(rte->rte_waypt_ct, file_out);
}
-static void
-lowranceusr4_route_leg_disp(const Waypoint* wpt)
+void
+LowranceusrFormat::lowranceusr4_route_leg_disp(const Waypoint* wpt) const
{
for (int i = 0; i < waypt_table->size(); i++) {
const Waypoint* cmp = waypt_table->at(i);
}
}
-
-static void
-lowranceusr4_route_trl(const route_head*)
+void
+LowranceusrFormat::lowranceusr4_route_trl(const route_head*) const
{
/* Mystery byte */
gbfputc(0x01, file_out); // end of Route info ??
}
-
-
-static void
-lowranceusr_trail_disp(const Waypoint* wpt)
+void
+LowranceusrFormat::lowranceusr_trail_disp(const Waypoint* wpt)
{
if (trail_point_count <= MAX_TRAIL_POINTS) {
int lat = lat_deg_to_mm(wpt->latitude);
}
}
-static void
-lowranceusr_merge_trail_hdr(const route_head* trk)
+void
+LowranceusrFormat::lowranceusr_merge_trail_hdr(const route_head* trk)
{
QString name;
if (++trail_count == 1) {
trail_point_count += (short) trk->rte_waypt_ct;
}
-static void
-lowranceusr_merge_trail_tlr(const route_head*)
+void
+LowranceusrFormat::lowranceusr_merge_trail_tlr(const route_head*)
{
if (trail_count == (int)track_count()) { /* last trail */
short num_trail_points = trail_point_count;
gbfputint16(num_section_points, file_out);
}
}
-static void
-
-lowranceusr_merge_trail_hdr_2(const route_head*)
+void
+LowranceusrFormat::lowranceusr_merge_trail_hdr_2(const route_head*)
{
continuous = 0;
}
-static void
-lowranceusr4_trail_hdr(const route_head* trail)
+void
+LowranceusrFormat::lowranceusr4_trail_hdr(const route_head* trail)
{
if (global_opts.debug_level >= 1) {
printf(MYNAME " writing trail %d (%s) with %d trailpoints\n",
gbfputint32(trail->rte_waypt_ct, file_out);
}
-static void
-lowranceusr4_trail_disp(const Waypoint* wpt)
+void
+LowranceusrFormat::lowranceusr4_trail_disp(const Waypoint* wpt) const
{
/* Some unknown bytes */
gbfputint16(0, file_out);
gbfputint32(0, file_out);
}
-static void
-data_write()
+void
+LowranceusrFormat::write()
{
QString buf;
int len;
} else {
// USR version 2 and 3 uses 16-bit count
gbfputint16(NumWaypoints, file_out);
- waypt_disp_all(lowranceusr_waypt_pr);
+ auto lowranceusr_waypt_pr_lambda = [this](const Waypoint* waypointp)->void {
+ lowranceusr_waypt_pr(waypointp);
+ };
+ waypt_disp_all(lowranceusr_waypt_pr_lambda);
}
} else {
// Ignore writeasicons option for all other USR versions
if ((len = strlen(opt_content_descr)) == 0) {
buf = QString("Waypoints, routes, and trails");
} else {
- if(len > MAXUSRSTRINGSIZE) {
+ if (len > MAXUSRSTRINGSIZE) {
opt_content_descr[MAXUSRSTRINGSIZE] = '\000'; // truncate it before copy
}
buf = opt_content_descr;
// USR version 2 & 3 use 16-bit count
gbfputint16(NumRoutes, file_out);
if (NumRoutes) {
- route_disp_all(lowranceusr_route_hdr, nullptr, lowranceusr_waypt_disp);
+ auto lowranceusr_waypt_disp_lambda = [this](const Waypoint* waypointp)->void {
+ lowranceusr_waypt_disp(waypointp);
+ };
+ auto lowranceusr_route_hdr_lambda = [this](const route_head* rte)->void {
+ lowranceusr_route_hdr(rte);
+ };
+ route_disp_all(lowranceusr_route_hdr_lambda, nullptr, lowranceusr_waypt_disp_lambda);
}
} else {
// All other USR formats use 32-bit count
gbfputint32(NumRoutes, file_out);
if (NumRoutes) {
- route_disp_all(lowranceusr4_route_hdr, lowranceusr4_route_trl, lowranceusr4_route_leg_disp);
+ auto lowranceusr4_route_leg_disp_lambda = [this](const Waypoint* waypointp)->void {
+ lowranceusr4_route_leg_disp(waypointp);
+ };
+ auto lowranceusr4_route_hdr_lambda = [this](const route_head* rte)->void {
+ lowranceusr4_route_hdr(rte);
+ };
+ auto lowranceusr4_route_trl_lambda = [this](const route_head* rte)->void {
+ lowranceusr4_route_trl(rte);
+ };
+ route_disp_all(lowranceusr4_route_hdr_lambda, lowranceusr4_route_trl_lambda, lowranceusr4_route_leg_disp_lambda);
}
}
// Ignore for all other USR versions
if (NumWaypoints && opt_writeasicons) {
gbfputint16(NumWaypoints, file_out);
- waypt_disp_all(lowranceusr_write_icon);
+ auto lowranceusr_write_icon_lambda = [this](const Waypoint* waypointp)->void {
+ lowranceusr_write_icon(waypointp);
+ };
+ waypt_disp_all(lowranceusr_write_icon_lambda);
} else {
short NumIcons = 0;
gbfputint16(NumIcons, file_out);
trail_point_count = 0;
trail_count = 0;
/* count the number of total trail points */
- track_disp_all(lowranceusr_merge_trail_hdr, lowranceusr_merge_trail_tlr, nullptr);
+ auto lowranceusr_merge_trail_hdr_lambda = [this](const route_head* rte)->void {
+ lowranceusr_merge_trail_hdr(rte);
+ };
+ auto lowranceusr_merge_trail_tlr_lambda = [this](const route_head* rte)->void {
+ lowranceusr_merge_trail_tlr(rte);
+ };
+ track_disp_all(lowranceusr_merge_trail_hdr_lambda, lowranceusr_merge_trail_tlr_lambda, nullptr);
/* write out the new trail header */
trail_point_count = 0;
- track_disp_all(lowranceusr_merge_trail_hdr_2, nullptr, lowranceusr_trail_disp);
+ auto lowranceusr_trail_disp_lambda = [this](const Waypoint* waypointp)->void {
+ lowranceusr_trail_disp(waypointp);
+ };
+ auto lowranceusr_merge_trail_hdr_2_lambda = [this](const route_head* rte)->void {
+ lowranceusr_merge_trail_hdr_2(rte);
+ };
+ track_disp_all(lowranceusr_merge_trail_hdr_2_lambda, nullptr, lowranceusr_trail_disp_lambda);
} else {
/* MERGE NEEDS SOME MORE WORK */
fatal(MYNAME " output file USR %d format is not supported with merge option\n", writing_version);
gbfputint16(NumTrails, file_out);
if (NumTrails) {
trail_count=0;
- track_disp_all(lowranceusr_trail_hdr, nullptr, lowranceusr_trail_disp);
+ auto lowranceusr_trail_disp_lambda = [this](const Waypoint* waypointp)->void {
+ lowranceusr_trail_disp(waypointp);
+ };
+ auto lowranceusr_trail_hdr_lambda = [this](const route_head* rte)->void {
+ lowranceusr_trail_hdr(rte);
+ };
+ track_disp_all(lowranceusr_trail_hdr_lambda, nullptr, lowranceusr_trail_disp_lambda);
}
} else {
// All other USR formats use 32-bit count
gbfputint32(NumTrails, file_out);
if (NumTrails) {
trail_count=0;
- track_disp_all(lowranceusr4_trail_hdr, nullptr, lowranceusr4_trail_disp);
+ auto lowranceusr4_trail_disp_lambda = [this](const Waypoint* waypointp)->void {
+ lowranceusr4_trail_disp(waypointp);
+ };
+ auto lowranceusr4_trail_hdr_lambda = [this](const route_head* rte)->void {
+ lowranceusr4_trail_hdr(rte);
+ };
+ track_disp_all(lowranceusr4_trail_hdr_lambda, nullptr, lowranceusr4_trail_disp_lambda);
}
}
}
}
-
-
-ff_vecs_t lowranceusr_vecs = {
- ff_type_file,
- FF_CAP_RW_ALL,
- rd_init,
- wr_init,
- rd_deinit,
- wr_deinit,
- data_read,
- data_write,
- nullptr,
- &lowranceusr_args,
- CET_CHARSET_ASCII, 0 /* CET-REVIEW */
- , NULL_POS_OPS,
- nullptr
-};
--- /dev/null
+/*
+ Access to Lowrance USR files.
+
+ Initial contribution to gpsbabel by Jason Rust (jrust at rustyparts.com)
+
+ Copyright (C) 2005 - 2018 Robert Lipe, robertlipe+source@gpsbabel.org
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program; if not, write to the Free Software
+ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+
+ HISTORY:
+
+ 6/21/05 - Ling Nero (rnlnero@yahoo.com)
+ - Added Routes, Icons, & Tracks support
+ - Fixed waypoint date/time stamp conversion
+ 02/09/08 - oliskoli
+ - gbfile API
+ - check for buffer overflows when reading names or comments
+ 02/25/2008 - Alan Porter (alan@kr4jb.net)
+ - Added new icons for Lowrance iFinder Expedition C
+ - Categorized geocaching waypoints using different icons
+ 01/06/2012 - Kris Beevers (beevek at gmail.com)
+ - First pass read-write support for USR 4 in lowranceusr4.cc
+ 10/02/2018 - BJ Kowalski (bj dot kowalski at gmail.com)
+ - Added support to lowranceusr4.cc for USR 4 route version 2
+ format data.
+ - Combined processing of USR 2/3/4/5/6 formats into a single
+ file. The previous implementation did not support conversion
+ between USR 2/3 and 4/5/6 or between 4/5/6 and 2/3 because of
+ the separation in processing between lowranceusr.cc and
+ lowranceusr4.cc.
+
+ USR Background Information
+
+ Collected from various WEB sources and Lowrance HOOK2 User Manual.
+
+ Lowrance Support Site - https://www.lowrance.com/help-and-support/
+ Hook2 Series Operator Manual (English) - //software.lowrance.com/Documents/Hook2-Series_OM_EN_988-11760-001_w.pdf
+ Lowrance Endura FAQs II - http://support.lowrance.com/system/selfservice.controller?CONFIGURATION=1001&PARTITION_ID=1&secureFlag=false&TIMEZONE_OFFSET=&CMD=VIEW_ARTICLE&ARTICLE_ID=2028
+ BBCBoards.Net : Lowrance Sonar/GPS Topic : Waypoints; USR Versions Thread : http://www.bbcboards.net/showthread.php?t=855028
+ Python USR4 (Version 4) to GPX Converter - http://lowranceusrv4togpxconverter.blogspot.com/2011/12/about-this-blog.html
+
+ User Data File version 6 - USRv6
+ Latest format.
+ Supports trail characteristics speed and temperature.
+
+ User Data File version 5 - USRv5
+ Lowrance introduced universally unique identifiers (UUIDs) in this version.
+
+ User Data File version 4 - USRv4
+ Seems to be the best option for transferring data from older Lowrance units.
+ Many of the counts (Number of Waypoints, Number of Routes, etc) were expanded from
+ 16-bit integer values (maximum value of 65,535) to 32-bit (maxumum value 2,147,483,647)
+ USRv4 and above support a maximum of 20,000 trail-points (actually 24K and change).
+ USRv4 and above and GPX support trails with trail-segments.
+
+ User Data File version 3 - USRv3
+ Legacy file format.
+ Added depth information to Route waypoints.
+ Supports trails with a maximum of 10,000 trail-points.
+ Last version that supports Event Marker ICONs.
+
+ User Data File version 2 - USRv2
+ Legacy file format.
+ This is the default output USR version used by GPSBabel.
+ This format contains ony basic information on waypoints, routes, and trails.
+
+ GPX (GPS Exchange)
+ Common format supported by many vendors and programs. Lowrance only provides
+ minimal support for GPX export with their HOOK2 series. Waypoints include
+ longitude, latitude, timestamp, name and symbol information. Routes include
+ name and for route points longitude, latitude, timestamp, name, and symbol.
+ Tracks include name and for track points longitude, latitude, and timestamp.
+
+*/
+#ifndef LOWRANCEUSR_H_INCLUDED_
+#define LOWRANCEUSR_H_INCLUDED_
+
+#include <cmath> // for M_PI, round, atan, exp, log, tan
+#include <ctime> // for time_t
+
+#include <QtCore/QList> // for QList
+#include <QtCore/QString> // for QString
+#include <QtCore/QStringRef> // for QStringRef
+#include <QtCore/QTextCodec> // for QTextCodec
+#include <QtCore/QVector> // for QVector
+#include <QtCore/Qt> // for CaseInsensitive
+#include <QtCore/QtGlobal> // for uint
+
+#include "defs.h"
+#include "format.h"
+#include "formspec.h" // for FsChainFind, FsChainAdd, kFsLowranceusr4, FormatSpecificData
+#include "gbfile.h" // for gbfgetint32, gbfputint32, gbfputint16, gbfgetc, gbfgetint16, gbfwrite, gbfputc, gbfeof, gbfgetflt, gbfclose, gbfgetdbl, gbfopen_le, gbfputdbl, gbfputs, gbfile, gbfputflt, gbfread, gbfseek
+#include "src/core/datetime.h" // for DateTime
+
+
+class LowranceusrFormat : public Format
+{
+public:
+ /* Member Functions */
+
+ QVector<arglist_t>* get_args() override
+ {
+ return &lowranceusr_args;
+ }
+
+ ff_type get_type() const override
+ {
+ return ff_type_file;
+ }
+
+ QVector<ff_cap> get_cap() const override
+ {
+ return FF_CAP_RW_ALL;
+ }
+
+ QString get_encode() const override
+ {
+ return CET_CHARSET_ASCII;
+ }
+
+ int get_fixed_encode() const override
+ {
+ return 0;
+ }
+
+ void rd_init(const QString& fname) override;
+ void read() override;
+ void rd_deinit() override;
+ void wr_init(const QString& fname) override;
+ void write() override;
+ void wr_deinit() override;
+
+private:
+ /* Types */
+
+ struct lowranceusr_icon_mapping_t {
+ int value;
+ const char* icon;
+ };
+
+ struct lowranceusr4_icon_mapping_t {
+ int value;
+ const char* icon;
+ const char* color[7];
+ };
+
+ struct lowranceusr4_fsdata : FormatSpecificData {
+ lowranceusr4_fsdata() : FormatSpecificData(kFsLowranceusr4) {}
+
+ lowranceusr4_fsdata* clone() const override
+ {
+ return new lowranceusr4_fsdata(*this);
+ }
+
+ uint uid_unit{0};
+ uint uid_unit2{0};
+ int uid_seq_low{0};
+ int uid_seq_high{0};
+ uint UUID1{0};
+ uint UUID2{0};
+ uint UUID3{0};
+ uint UUID4{0};
+ int flags{0};
+ int color{0};
+ const char* color_desc{nullptr};
+ int icon_num{0};
+ float depth{0.0};
+ };
+
+ struct Lowranceusr4Timestamp
+ {
+ unsigned int julian_day_number;
+ unsigned int milliseconds;
+
+ Lowranceusr4Timestamp(unsigned int jd, unsigned int ms) : julian_day_number{jd}, milliseconds{ms} {}
+ };
+
+ /* Constants */
+
+ static constexpr int DEF_ICON = 10001;
+ static constexpr int X_1_ICON = 10003;
+ static constexpr const char* DISABLED_CACHE_TXT = "Disabled Cache";
+
+// MSVC 2015 will error with C2373 if the array length isn't explicitly included.
+#if !defined(_MSC_VER) || (_MSC_VER >= 1910) /* !MSVC or MSVC 2017 or newer */
+ static constexpr lowranceusr_icon_mapping_t lowranceusr_icon_value_table[] = {
+#else
+ static constexpr lowranceusr_icon_mapping_t lowranceusr_icon_value_table[134] = {
+#endif
+
+ /* Taken from iFinder 1.8 */
+
+ { 10000, "diamond 1" }, // a.k.a. WPTa on iFinder Hunt C
+ { 10001, "diamond 2" }, // a.k.a. WPTb on iFinder Hunt C
+ { 10002, "diamond 3" },
+ { X_1_ICON, "x 1" }, // a.k.a. Xa on iFinder Hunt C
+ { 10004, "x 2" }, // a.k.a. Xb on iFinder Hunt C
+ { 10005, "x 3" },
+ { 10006, "red cross" },
+ { 10007, "house" },
+ { 10008, "car" }, // a.k.a. vehicle on iFinder Hunt C
+ { 10009, "store" },
+ { 10010, "gas station" }, // a.k.a. gas on iFinder Hunt C
+ { 10011, "fork and spoon" }, // a.k.a. food on iFinder Hunt C
+ { 10012, "telephone" }, // a.k.a. phone on iFinder Hunt C
+ { 10013, "airplane" },
+ { 10014, "exit sign" },
+ { 10015, "stop sign" },
+ { 10016, "exclamation" },
+ { 10017, "traffic light" },
+ { 10018, "american flag" },
+ { 10019, "person" }, // a.k.a. partner on iFinder Hunt C
+ { 10020, "restrooms" },
+ { 10021, "tree" },
+ { 10022, "mountains" },
+ { 10023, "campsite" }, // a.k.a. camp on iFinder Hunt C
+ { 10024, "picnic table" }, // a.k.a. picnic on iFinder Hunt C
+ { 10025, "deer" }, // a.k.a. big game on iFInder Hunt C
+ { 10026, "deer tracks" },
+ { 10027, "turkey tracks" },
+ { 10028, "tree stand" },
+ { 10029, "bridge" },
+ { 10030, "skull and crossbones" }, // a.k.a. skull on iFinder Hunt C
+ { 10031, "fish" },
+ { 10032, "two fish" },
+ { 10033, "dive flag" },
+ { 10034, "wreck" },
+ { 10035, "anchor" },
+ { 10036, "boat" },
+ { 10037, "boat ramp" },
+ { 10038, "flag buoy" },
+ { 10039, "dam" },
+ { 10040, "swimmer" },
+ { 10041, "pier"},
+
+ /* The descriptions come from Alan Porter <alan@kr4jb.net>, using an iFinder Expedition C */
+ /* Updated by bj.kowalski with ICON names from iFinder Hunt C SW Version 1.2.0 */
+
+ { 10042, "icon42" }, // black box with red X
+ { 10043, "red dot" }, // small red dot (route point)
+ { 10044, "atv" }, // 4-wheeler
+ { 10045, "blind" }, // hiding hunter
+ { 10046, "oak tree" }, // tree (yellow base)
+ { 10047, "icon47" }, // windmill
+ { 10048, "camera" }, // camera
+ { 10049, "rub" }, // tree (something in front of base)
+ { 10050, "scrape" }, // tree (something hanging from left side)
+ { 10051, "droppings" }, // 4 dots in rhombus shape
+ { 10052, "roost tree" }, // bare winter tree
+ { 10053, "animal bed" }, // hiding deer head peeking over bushes
+ { 10054, "feeder" }, // piston? over a pile of salt?
+ { 10055, "food plot" }, // corn
+ { 10056, "turkey" }, // turkey
+ { 10057, "waterfowl" }, // duck
+ { 10058, "upland" }, // hen
+ { 10059, "small game" }, // rabbit
+ { 10060, "predator paw" }, // paw print
+ { 10061, "blood" }, // 2 red flames?
+
+ /* This list comes from 'wifinder' from ifinder H20 Color */
+
+ { 10062, "Interesting Land Feature" },
+ { 10063, "Global Location" },
+ { 10064, "Note" },
+ { 10065, "Ghost" },
+ { 10066, "Letter" },
+ { 10067, "Multi-Treasure" },
+ { 10068, "Mystery Or Puzzle" },
+ { 10069, "Treasure" },
+ { 10070, "Webmail" },
+ { 10071, "Sun" },
+ { 10072, "Musical Note" },
+ { 10073, "Camera/Movie Theater" },
+ { 10074, "Star" },
+ { 10075, "Coffee Mug" },
+ { 10076, "Books" },
+ { 10077, "Historical Marker" },
+ { 10078, "Tools/Repair" },
+ { 10079, "Favorite" },
+ { 10080, "Arena" },
+ { 10081, "Golf Course" },
+ { 10082, "Money/Atm" },
+
+ /* This list comes from HOOK2 provided by BJ.Kowalski */
+
+ { 10083, "longgrass" },
+ { 10084, "rocks" },
+ { 10086, "hump" },
+ { 10087, "hole" },
+
+ /* The following list is from TopoFusion */
+
+ { 10000, "Waypoint" }, /* diamond 1 */
+ { DEF_ICON, "Text Label (No Dot)" },
+ { 10018, "Trailhead" }, /* american flag */
+ { 10023, "Campground" }, /* campsite */
+ { 10022, "Summit" }, /* mountains */
+ { DEF_ICON, "Tall Tower" },
+ { DEF_ICON, "Short Tower" },
+ { 10021, "Forest" }, /* tree */
+ { DEF_ICON, "Mine" },
+// { 10038, "Geocache" }, /* flag buoy */
+// { 10016, "Geocache Found" }, /* exclamation */
+ { DEF_ICON, "Skiing Area" },
+ { 10029, "Crossing" }, /* bridge */
+ { 10007, "House" }, /* house */
+ { X_1_ICON, "Dot" }, /* x 1 */
+ { 10025, "Hunting Area" }, /* deer */
+ { 10031, "Fishing Area" }, /* fish */
+ { 10040, "Swimming Area" }, /* swimmer */
+ { 10012, "Telephone" }, /* telephone */
+ { 10024, "Rest Area" }, /* picnic table */
+ { 10021, "Park" }, /* tree */
+ { 10007, "Information" }, /* house */
+ { 10022, "Scenic Area" }, /* mountains */
+ { DEF_ICON, "Bank/Dollar" },
+ { 10009, "Hotel" }, /* store */
+ { 10011, "Restaurant" }, /* fork and spoon */
+ { 10030, "Danger Area" }, /* skull and crossbones */
+ { 10035, "Anchor" }, /* anchor */
+ { 10002, "City (Large)" }, /* diamond 3 */
+ { 10001, "City (Medium)" }, /* diamond 2 */
+ { 10000, "City (Small)" }, /* diamond 1 */
+ { DEF_ICON, "Drinking Water" },
+ { 10008, "Parking Area" }, /* car */
+ { 10023, "RV Park" }, /* campsite */
+ { 10020, "Rest Room" }, /* restroom */
+ { 10019, "Shower" }, /* person */
+ { DEF_ICON, "Tunnel" },
+
+ /* These are the icons that gpsbabel will use */
+
+ { 10038, "Geocache" }, // flag buoy
+ { 10016, "Geocache Found" }, // exclamation
+ { 10043, "Micro-Cache" }, // small red dot
+ { 10065, "Virtual cache" }, // ghost
+ { 10051, "Multi-Cache" }, // 4 dots in rhombus shape
+ { 10068, "Unknown Cache" }, // ? mark
+ { 10045, "Locationless (Reverse) Cache" }, // hiding hunter
+ { 10066, "Post Office" }, // letter
+ { 10019, "Event Cache" }, // person
+ { 10070, "Webcam Cache" }, // webcam
+ { 10042, DISABLED_CACHE_TXT }, // black box with red X
+
+ // END OF ICON MAPPING
+ { -1, nullptr }
+ };
+
+ static constexpr int DEF_USR4_ICON = 2;
+ static constexpr int DEF_USR4_COLOR = 0;
+
+// MSVC 2015 will error with C2373 if the array length isn't explicitly included.
+#if !defined(_MSC_VER) || (_MSC_VER >= 1910) /* !MSVC or MSVC 2017 or newer */
+ static constexpr lowranceusr4_icon_mapping_t lowranceusr4_icon_value_table[] = {
+#else
+ static constexpr lowranceusr4_icon_mapping_t lowranceusr4_icon_value_table[22] = {
+#endif
+
+ /* USR GPX Symbol COLOR1 COLOR2 COLOR3 COLOR4 COLOR5 COLOR6 COLOR7 HOOK2 Displays */
+
+ { 1, "diamond 1", { "blue", "magenta", "orange", "yellow", "green", "aqua", "white" }}, // diamond
+ { 0, "diamond 1", { "blue", "magenta", "orange", "yellow", "green", "aqua", "white" }}, // diamond
+ { 1, "diamond 2", { "blue", "magenta", "orange", "yellow", "green", "aqua", "white" }}, // diamond
+ { 1, "diamond 3", { "blue", "magenta", "orange", "yellow", "green", "aqua", "white" }}, // diamond
+ { 2, "x 1", { "blue", "magenta", "orange", "yellow", "green", "aqua", "white" }}, // X
+ { 2, "x 2", { "blue", "magenta", "orange", "yellow", "green", "aqua", "white" }}, // X
+ { 2, "x 3", { "blue", "magenta", "orange", "yellow", "green", "aqua", "white" }}, // X
+ { 4, "fish", { "green", "aqua", "blue", "magenta", "red", "yellow", "white" }}, // single fish
+ { 5, "two fish", { "aqua", "blue", "red", "orange", "yellow", "green", "white" }}, // schoolfish
+ { 8, "hole", { "aqua", "blue", "red", "orange", "yellow", "green", "white" }}, // dip sign
+ { 9, "hump", { "aqua", "blue", "red", "orange", "yellow", "green", "white" }}, // bump sign
+ { 10, "longgrass", { "green", "aqua", "blue", "red", "orange", "yellow", "white" }}, // long grass
+ { 12, "rocks", { "blue", "magenta", "orange", "yellow", "green", "aqua", "white" }}, // rocks
+ { 17, "gas station", { "red", "yellow", "green", "aqua", "blue", "magenta", "white" }}, // gas pump
+ { 28, "tree", { "green", "aqua", "blue", "magenta", "red", "yellow", "white" }}, // tree
+ { 30, "campsite", { "yellow", "green", "aqua", "blue", "magenta", "red", "white" }}, // tent
+ { 37, "skull and crossbones", { "blue", "magenta", "orange", "yellow", "green", "aqua", "white" }}, // skull and crossbones
+ { 40, "dive flag", { "red", "yellow", "green", "aqua", "blue", "magenta", "white" }}, // diveflag
+ { 42, "anchor", { "blue", "magenta", "orange", "yellow", "green", "aqua", "white" }}, // anchor
+ { 44, "boat ramp", { "red", "yellow", "green", "aqua", "blue", "magenta", "white" }}, // boatramp
+ { 48, "pier", { "blue", "magenta", "orange", "yellow", "green", "aqua", "white" }}, // pier
+
+ // END OF ICON MAPPING
+ { -1, nullptr, { nullptr, nullptr, nullptr, nullptr, nullptr, nullptr, nullptr }}
+ };
+
+ static constexpr int MAXUSRSTRINGSIZE = 256;
+ static constexpr double SEMIMINOR = 6356752.3142;
+ static constexpr double DEGREESTORADIANS = M_PI/180.0;
+ static constexpr int MAX_TRAIL_POINTS = 9999;
+ static constexpr double UNKNOWN_USR_ALTITUDE = METERS_TO_FEET(-10000); /* -10000ft is how the unit stores unknown */
+ static constexpr time_t base_time_secs = 946706400; /* Jan 1, 2000 00:00:00 */
+
+ /* Member Functions */
+
+ static char same_points(const Waypoint*, const Waypoint*);
+ void register_waypt(const Waypoint*) const;
+ const Waypoint* lowranceusr4_find_waypt(uint, int, int) const;
+ const Waypoint* lowranceusr4_find_global_waypt(uint, uint, uint, uint) const;
+ QString lowranceusr4_readstr(gbfile*, int) const;
+ void lowranceusr4_writestr(const QString&, gbfile*, int) const;
+ static gpsbabel::DateTime lowranceusr4_get_timestamp(unsigned int, unsigned int);
+ static Lowranceusr4Timestamp lowranceusr4_jd_from_timestamp(const gpsbabel::DateTime&);
+ static QString lowranceusr_find_desc_from_icon_number(int);
+ static int lowranceusr_find_icon_number_from_desc(const QString&);
+ static QString lowranceusr4_find_desc_from_icon_number(int);
+ static int lowranceusr4_find_icon_number_from_desc(const QString&);
+ static const char* lowranceusr4_find_color_from_icon_number_plus_color_index(int, int);
+ static int lowranceusr4_find_index_from_icon_desc_and_color_desc(const QString&, const QString&);
+ static double lon_mm_to_deg(double);
+ static double lat_mm_to_deg(double);
+ static long int lon_deg_to_mm(double);
+ static long int lat_deg_to_mm(double);
+ void lowranceusr_parse_waypt(Waypoint*, int) const;
+ void lowranceusr4_parse_waypt(Waypoint*) const;
+ void lowranceusr_parse_waypts() const;
+ void lowranceusr_parse_route() const;
+ void lowranceusr4_parse_route() const;
+ void lowranceusr_parse_routes();
+ void lowranceusr_parse_icons() const;
+ void lowranceusr_parse_trail(int*);
+ void lowranceusr4_parse_trail(int*) const;
+ void lowranceusr_parse_trails();
+ void lowranceusr_waypt_disp(const Waypoint*) const;
+ void lowranceusr4_waypt_disp(const Waypoint*);
+ void lowranceusr_waypt_pr(const Waypoint*);
+ void lowranceusr4_write_waypoints();
+ void lowranceusr_write_icon(const Waypoint*) const;
+ void lowranceusr_trail_hdr(const route_head*);
+ void lowranceusr_route_hdr(const route_head*);
+ void lowranceusr4_route_hdr(const route_head*);
+ void lowranceusr4_route_leg_disp(const Waypoint*) const;
+ void lowranceusr4_route_trl(const route_head*) const;
+ void lowranceusr_trail_disp(const Waypoint*);
+ void lowranceusr_merge_trail_hdr(const route_head*);
+ void lowranceusr_merge_trail_tlr(const route_head*);
+ void lowranceusr_merge_trail_hdr_2(const route_head*);
+ void lowranceusr4_trail_hdr(const route_head*);
+ void lowranceusr4_trail_disp(const Waypoint*) const;
+
+ /* Data Members */
+
+ gbfile* file_in;
+ gbfile* file_out;
+ short_handle mkshort_handle;
+
+ route_head* trk_head;
+ route_head* rte_head;
+
+ int waypt_uid;
+ int route_uid;
+ int trail_uid;
+
+ char* opt_ignoreicons;
+ char* opt_writeasicons;
+ char* opt_seg_break;
+ char* opt_wversion;
+ char* opt_title;
+ char* opt_content_descr;
+ char* opt_serialnum;
+ int opt_serialnum_i;
+
+ QList<const Waypoint*>* waypt_table{nullptr};
+
+ unsigned short waypt_out_count;
+ int trail_count, lowrance_route_count;
+ int trail_point_count;
+ char continuous = 1;
+ short num_section_points;
+ char* merge;
+ int reading_version;
+ int rstream_version;
+ int writing_version;
+ QTextCodec* utf16le_codec{nullptr};
+
+ template <typename T>
+ static QString lowranceusr_common_find_desc_from_icon_number(const int icon, const T icon_value_table[])
+ {
+ for (const T* i = icon_value_table; i->icon; ++i) {
+ if (icon == i->value) {
+ return i->icon;
+ }
+ }
+
+ // Didn't find it in table, default to leave it as the number found
+ return QString("icon-%1").arg(icon);
+ }
+
+ template <typename T>
+ static int lowranceusr_common_find_icon_number_from_desc(const QString& desc, const T icon_value_table[], const int def_icon)
+ {
+ if (desc.isNull()) {
+ return def_icon;
+ }
+
+ /*
+ * If we were given a numeric icon number as a description
+ * (i.e. 8255), just return that.
+ * Also return the icon number for descriptions of "icon-"
+ * followed by a numeric icon number.
+ */
+ int n = desc.midRef(desc.startsWith("icon-") ? 5 : 0).toInt();
+ if (n) {
+ return n;
+ }
+
+ for (const T* i = icon_value_table; i->icon; ++i) {
+ if (desc.compare(i->icon,Qt::CaseInsensitive) == 0) {
+ return i->value;
+ }
+ }
+
+ return def_icon;
+ }
+
+// Combined arguments from previous lowranceusr and lowranceusr4 into single set.
+// Use output format specified to determine if args are ignored.
+ QVector<arglist_t> lowranceusr_args = {
+ {
+ // Ignore Event Marker ICONs in input data
+ "ignoreicons", &opt_ignoreicons, "(USR input) Ignore event marker icons on read",
+ nullptr, ARGTYPE_BOOL, ARG_NOMINMAX, nullptr
+ },
+ {
+ // Write Waypoint data as Event Marker ICONs
+ "writeasicons", &opt_writeasicons, "(USR output) Treat waypoints as icons on write",
+ nullptr, ARGTYPE_BOOL, ARG_NOMINMAX, nullptr
+ },
+ {
+ "merge", &merge, "(USR output) Merge into one segmented trail",
+ nullptr, ARGTYPE_BOOL, ARG_NOMINMAX, nullptr
+ },
+ {
+ "break", &opt_seg_break, "(USR input) Break segments into separate trails",
+ nullptr, ARGTYPE_BOOL, ARG_NOMINMAX, nullptr
+ },
+ {
+ // Specify the Output USR Version to be generated
+ "wversion", &opt_wversion, "(USR output) Write version",
+ "2", ARGTYPE_INT, "2", "4", nullptr
+ },
+ {
+ // Only used if Write Version is 4/5/6
+ "title", &opt_title, "(USR output) Output file title string",
+ "", ARGTYPE_STRING, ARG_NOMINMAX, nullptr
+ },
+ {
+ // Only used if Write Version is 4/5/6
+ "serialnum", &opt_serialnum, "(USR output) Device serial number",
+ "0", ARGTYPE_INT, ARG_NOMINMAX, nullptr
+ },
+ {
+ // Only used if Write Version is 4/5/6
+ "description", &opt_content_descr, "(USR output) Output file content description",
+ "", ARGTYPE_STRING, ARG_NOMINMAX, nullptr
+ },
+
+ };
+};
+#endif // LOWRANCEUSR_H_INCLUDED_
projects / gpsbabel.git / commitdiff